Documentation Writer Agent

概述

Documentation Writer Agent 是一个专门负责创建 API 文档、用户指南和架构文档的技术写作子代理。

关键内容

1. 主要职责：
2. 创建清晰、完整的文档
3. 分析要记录的代码或功能
4. 确定目标读者
5. 按项目规范编写文档

6. 根据实际代码验证文档准确性

7. 文档类型：

8. 带示例的 API 文档
9. 用户指南和教程
10. 架构文档
11. Changelog 条目

12. 代码注释改进

13. 文档标准：

14. 清晰 - 使用简单、明确的语言
15. 示例 - 包含实用的代码示例
16. 完整 - 覆盖所有参数和返回值
17. 结构 - 使用一致的格式
18. 准确 - 根据实际代码验证

来源

• raw/assets/claude-howto/04-subagents/documentation-writer.md — 源文件

相关

• Subagent — relates_to
• API文档生成器 — relates_to
• 技术文档 — relates_to